home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / wp / dtsrc112.zip / README.DTS < prev    next >
Text File  |  1992-05-25  |  20KB  |  440 lines

  1.  
  2.  
  3.  
  4.  
  5.                                                                May 25, 1992
  6.                                 d t S e a r c h  1.12
  7.  
  8.           How to install dtSearch:
  9.  
  10.                * If you have the registered version, please follow the
  11.                directions in the manual.
  12.  
  13.                * If you have the shareware version, there may be included
  14.                an "INSTALL.EXE" file.  This just creates a directory to
  15.                hold the dtSearch program files and executes the self-
  16.                extracting archive file DTSRCH.EXE.  If you have
  17.                INSTALL.EXE, you can use it to install dtSearch.  If not,
  18.                just unpack the files into a directory on your hard disk.
  19.  
  20.           dtSearch includes the following files:
  21.  
  22.           File Name     Purpose of File:
  23.           ------------  ---------------------------------------------------
  24.           DTSEARCH.DOC   Printable copy of the dtSearch manual
  25.           DTSEARCH.EXE   The dtSearch program
  26.           DTSEARCH.HLP   The hypertext help database for dtSearch
  27.           DTSEARCH.MNU   A menu data file for dtSearch
  28.           DTS_SAFE.MNU   An alternative menu data file for dtSearch
  29.           DTSEARCH.NOI   List of "noise" words for dtSearch
  30.           DTSEARCH.REG   A screen data file for dtSearch (registered
  31.                          version only)
  32.           DTSEARCH.SCR   A screen data file for dtSearch
  33.  
  34.           ORDER.DTS      Registration information and order form
  35.           README.DTS     Important last-minute information
  36.           SITELICE.DTS   Site license information and agreement
  37.           UPGRADE.DTS    Version history and upgrade information
  38.           VENDOR.DTS     Information and restrictions for disk vendors,
  39.                          distributors, BBS sysops, user groups, etc.
  40.  
  41.  
  42.  
  43.                                         - 2 -
  44.  
  45.  
  46.                                  Upgrade Information
  47.  
  48.           From version 1.0:
  49.  
  50.                Document indexes and setup files created with dtSearch 1.0
  51.                will not work properly with version 1.12.  Although version
  52.                1.12 can read indexes created with version 1.0, using
  53.                version 1.12 to search for documents in an index created
  54.                with version 1.0 may result in incorrect words being
  55.                highlighted as "hits" when documents are retrieved. 
  56.                Therefore, if you are upgrading from version 1.0, you should
  57.                delete all of the version 1.0 files and indexes and reindex
  58.                your documents.
  59.  
  60.           From version 1.1 or version 1.11:
  61.  
  62.                Version 1.12 is compatible with versions 1.1 or 1.11.  You
  63.                can upgrade to version 1.12 by simply installing the files
  64.                from this version into your DTSEARCH directory.  Do not
  65.                delete the existing dtSearch files.
  66.  
  67.                If you are a registered user of an earlier version of
  68.                dtSearch, you do not have to register version 1.12.  You can
  69.                simply install the shareware version of dtSearch 1.12 in
  70.                your DTSEARCH directory.  The only difference between the
  71.                shareware version of dtSearch and the registered version is
  72.                the DTSEARCH.REG file, which suppresses the registration
  73.                reminder screen.  The DTSEARCH.REG file included in your
  74.                registered dtSearch package will work with version 1.12. 
  75.                Therefore, all you have to do to upgrade is to install the
  76.                new version of dtSearch in your DTSEARCH directory.
  77.  
  78.                Some very minor changes in the way dtSearch counts words in
  79.                documents were made in version 1.12.  If you notice that
  80.                dtSearch is highlighting the wrong words as hits when it
  81.                displays a retrieved document, you should delete your
  82.                existing indexes and reindex your documents with version
  83.                1.12.  Most users should not need to do this.
  84.  
  85.  
  86.  
  87.                                         - 3 -
  88.  
  89.                                     dtSearch 1.12
  90.  
  91.                               Supplemental Documentation
  92.  
  93.                                      May 25, 1992
  94.  
  95.           A.  Tips for faster indexing
  96.  
  97.           *    Give dtSearch as much conventional memory as you can.
  98.                dtSearch is designed to be able to run with very little
  99.                memory available -- as little as 384k.  However, it runs
  100.                most efficiently with plenty of memory.
  101.  
  102.           *    Use a hard disk cache, such as Central Point Software's
  103.                PC-CACHE or Microsoft's SMARTDRV.SYS.  A hard disk cache is
  104.                a program that makes your hard disk seem faster by storing
  105.                recently-used data in memory so it can be accessed again
  106.                quickly.  dtSearch runs much faster with a hard disk cache.
  107.  
  108.           B.  DESQview Support
  109.  
  110.                Use the following DESQview parameters to run dtSearch in a
  111.           DESQview window:
  112.  
  113.           Memory Size (in K): 384
  114.  
  115.           Options:
  116.                Writes text directly to screen.........: [N]
  117.                Displays graphics information..........: [N]
  118.                Virtualize text/graphics (Y,N,T).......: [Y]
  119.                Uses serial ports (Y,N,1,2)............: [N]
  120.                Requires floppy diskette...............: [N]
  121.  
  122.           C.  Limited Access Menu
  123.  
  124.                dtSearch 1.12 includes an alternative menu file
  125.           DTS_SAFE.MNU, which only allows users to perform indexed searches
  126.           and view the results of searches.  The purpose of the limited
  127.           access menu is to provide a way for network administrators and
  128.           bulletin-board operators to give their users simplified and
  129.           limited access to document indexes.  To run dtSearch using this
  130.           menu, enter the command:
  131.  
  132.                DTSEARCH /MENU DTS_SAFE.MNU
  133.  
  134.           This menu will allow users to: (1) perform indexed searches; (2)
  135.           view results of prior searches; (3) create search reports; (4)
  136.           select index libraries; and (5) print the contents of a window. 
  137.           Indexing features, the notepad editor, directory browsing, and
  138.           unindexed searches are unavailable to a user running dtSearch
  139.           with this menu.
  140.  
  141.  
  142.  
  143.                                         - 4 -
  144.  
  145.           D.  The NOT and NOT W/N search connectors
  146.  
  147.           (NOTE: This section supplements Chapter 6 of the User's Manual,
  148.           which describes search requests.)
  149.  
  150.                You can use NOT in front of any search expression to reverse
  151.           its meaning.  This allows you to exclude documents from a search. 
  152.           For example, 
  153.  
  154.                apple sauce AND NOT pear
  155.  
  156.           would retrieve documents containing the phrase "apple sauce" and
  157.           not containing the word "pear".  Alternatively, you could search
  158.           for
  159.  
  160.                NOT pear
  161.  
  162.           and retrieve all documents that did not contain the word "pear". 
  163.           Other examples:
  164.  
  165.                apple OR NOT pear   Retrieve documents that either (1)
  166.                                    contain the word "apple," or (2) do not
  167.                                    contain the word "pear".
  168.  
  169.                NOT (apple w/5 pear)
  170.                                    Retrieve documents that do not contain
  171.                                    the word "apple" within 5 words of the
  172.                                    word "pear".  Note the use of
  173.                                    parenthesis to make the request
  174.                                    unambiguous.
  175.  
  176.           The NOT W/ ("not within") operator allows you to search for a
  177.           word or phrase not in association with another word or phrase. 
  178.           For example, 
  179.  
  180.                apple NOT W/20 pear
  181.  
  182.           would search for instances of the phrase "apple" more than 20
  183.           words away from the word "pear".  It will also retrieve files
  184.           containing "apple" with no instances of "pear".
  185.  
  186.           Unlike the W/ operator, NOT W/ is not symmetrical.  That is,
  187.           "apple NOT W/20 pear" is not the same as "pear NOT w/20 apple". 
  188.           In the "apple NOT W/20 pear" request, dtSearch searches for the
  189.           word "apple" and excludes cases where "apple" is too close to the
  190.           word "pear".  In the "pear NOT W/20 apple" request, dtSearch
  191.           searches for the word "pear" and excludes cases where "pear" is
  192.           too close to "apple".
  193.  
  194.  
  195.  
  196.                                         - 5 -
  197.  
  198.           E.  Binary files
  199.  
  200.                When dtSearch builds an index of a group of files, it
  201.           automatically detects and skips "binary" files such as executable
  202.           programs and data files that do not contain text.  If a file uses
  203.           a word processor format that dtSearch does not recognize,
  204.           dtSearch may classify it as "binary."
  205.  
  206.                If dtSearch finds any binary files during an indexing job,
  207.           dtSearch will display a message at the end of the job indicating
  208.           the number of binary files.  The file INDEXLOG.TXT will list the
  209.           files.  INDEXLOG.TXT is re-written each time an index is updated,
  210.           so binary files from previous indexing jobs will not be listed. 
  211.           If you are using batch mode indexing, the .LOG file created from
  212.           your script will list the binary files.
  213.  
  214.                You can tell dtSearch not to skip binary files by setting
  215.           the "Index binary files" option in the Options menu to "Yes."
  216.  
  217.           F.  New Error Messages
  218.  
  219.           "Error reading WordPerfect file"
  220.  
  221.                WordPerfect files occasionally become corrupted due to disk
  222.                problems or WordPerfect bugs.  Prior versions of dtSearch
  223.                would sometimes crash if a corrupted WordPerfect file was
  224.                encountered while searching or indexing.  In this version,
  225.                dtSearch checks for corruption in a WordPerfect file and
  226.                will display this message if it finds erroneous data.
  227.  
  228.                Here are some steps you can take to repair a corrupt
  229.                WordPerfect file (make a backup copy of the original file
  230.                first!).  (1) Retrieve the file into WordPerfect, scroll to
  231.                the end of the file, and save the document.  Often,
  232.                WordPerfect will detect and remove the corrupt data. 
  233.                However, you may also lose some text.  (2) Try one of the 
  234.                programs that claim to be able to repair damaged WordPerfect
  235.                files.  One such program is WPMD, which is shareware.  (3)
  236.                Get the most recent maintenance release of WordPerfect from
  237.                WordPerfect Corp. and try step (1).
  238.  
  239.           "Warning: document contains more than 64,000 words"
  240.  
  241.                dtSearch can handle documents up to 64,000 words long (about
  242.                300 double-spaced pages).  If a document is longer than
  243.                that, dtSearch will stop searching or indexing after the
  244.                64,000th word and display this message.  To suppress this
  245.                message, set the "Warning for too-long documents" option in
  246.                the Options menu to "No."
  247.  
  248.  
  249.  
  250.                                         - 6 -
  251.  
  252.           G.  Batch Mode Indexing
  253.  
  254.                Batch mode indexing allows you to create, update, and
  255.           compress a document index by running dtSearch from a batch file. 
  256.           (For information about creating batch files, see your DOS
  257.           manual.)  Batch mode indexing can be useful if, for example, you
  258.           want to perform a complex and time-consuming series of tasks
  259.           every night to update your indexes.
  260.  
  261.           1.  Overview
  262.  
  263.                To set up a batch indexing job, first create a "script" that
  264.           lists the tasks that you want dtSearch to perform.  A script is a
  265.           text file that lists a series of indexing commands that dtSearch
  266.           will carry out.
  267.  
  268.                The easiest way to create a script is to use the "Create
  269.           Batch Script" option in the Index menu.  When you select this
  270.           option, a dialog box will appear that is almost identical to the
  271.           "Update Index" dialog box.  At the top of the box will be a line
  272.           where you can specify the name of the script you want to create.
  273.  
  274.                Fill out the rest of the box exactly as you would if you
  275.           were updating an index.  If you want to create a new index for
  276.           your batch job, use the "Create Index" section of the dialog box. 
  277.           See the manual section on Indexing Documents for more information
  278.           about the options in the Create Batch Script dialog box.
  279.  
  280.                When you are done setting up the indexing job, select the
  281.           "Create Script" button at the bottom of the dialog box to create
  282.           the batch script.  dtSearch will then store all of the
  283.           information you have provided (the index to update, the
  284.           directories to index, etc.) in a script file that you can run
  285.           later.
  286.  
  287.                To run the script that you created, exit dtSearch and type
  288.           the following at the DOS prompt:
  289.  
  290.                DTSEARCH /SCRIPT MYSCRIPT.JOB
  291.  
  292.           where "MYSCRIPT.JOB" is the name of your script.  dtSearch will
  293.           then perform the indexing task you specified.  dtSearch will
  294.           record any errors encountered during the job in a file called
  295.           MYSCRIPT.LOG.  Errors will not be displayed on the screen, since
  296.           dtSearch assumes that batch jobs will run without someone
  297.           watching them.  After a batch indexing job, you should check the
  298.           log file to see if any errors occured.
  299.  
  300.                This is all that you need to know to set up basic batch
  301.           indexing tasks.  The rest of this section provides information
  302.           for more advanced use of batch mode indexing.
  303.  
  304.  
  305.  
  306.                                         - 7 -
  307.  
  308.           2.  Script files
  309.  
  310.                A script file is any text file that dtSearch can read.  You
  311.           can create a script using the "Create Batch Script" option in the
  312.           Index menu, or you can create a script by hand.  Before you try
  313.           to write your own scripts, you may want to create an example
  314.           using the "Create Batch Script" function so you can see what a
  315.           batch script looks like.
  316.  
  317.                A script can be ASCII text or it can be in one of the word
  318.           processor formats that dtSearch recognizes, such as WordPerfect
  319.           or WordStar.  The first line of a script must consist of the
  320.           words DTSEARCH SCRIPT.
  321.  
  322.                A script consists of a series of "SET" statements that
  323.           specify the documents to be indexed and the index to use, and
  324.           commands such as "ADD" and "COMPRESS".  dtSearch ignores any line
  325.           beginning with a *, so you can include comments in a script. 
  326.           Here is an example:
  327.  
  328.                DTSEARCH SCRIPT
  329.                * Add documents from C:\DOCS 
  330.                SET INDEXNAME = MyIndex
  331.                SET DOCPATH = C:\DOCS
  332.                SET FILTER = *.DOC *.TXT *.WPF
  333.                ADD
  334.                COMPRESS
  335.  
  336.           This script would index documents in the directory C:\DOCS,
  337.           storing information about the documents in the index called
  338.           "MyIndex", and would compress the index.  To run this script, put
  339.           it in the file UPDATE.JOB and execute the command:
  340.  
  341.                DTSEARCH /SCRIPT UPDATE.JOB
  342.  
  343.           dtSearch will then execute the script, logging any error messages
  344.           to the file UPDATE.LOG.  
  345.  
  346.           3.  Creating an index
  347.  
  348.                To create an index, set up a script like this:
  349.  
  350.                SET INDEXNAME = MyIndex
  351.                SET INDEXPATH = C:\DOCINDEX
  352.                CREATE
  353.  
  354.           The two SET statements tell the program what you want to call the
  355.           index and the directory you want to put it into.  The "CREATE"
  356.           statement tells dtSearch to create the index in the specified
  357.           directory.
  358.  
  359.  
  360.  
  361.                                         - 8 -
  362.  
  363.           WARNING:  Please be careful when using CREATE.  If you create an
  364.           index that already exists, dtSearch will delete the old index and
  365.           create a new, empty index in its place.  In interactive mode, you
  366.           will get a warning message before this happens, but in batch mode
  367.           dtSearch simply assumes that you really want to create a new
  368.           index.
  369.  
  370.           4.  Adding documents to an index
  371.  
  372.                To add documents to an index, use "SET DOCPATH =" to tell
  373.           dtSearch the directory in which the documents are located and
  374.           "SET FILTER =" to specify the file name filters.  Then use the
  375.           "ADD" command to add the documents to the index.  If you want to
  376.           index documents in several directories, use multiple
  377.           "SET DOCPATH =" statements separated by "ADD" commands.  Example:
  378.  
  379.                SET INDEXNAME = MyIndex
  380.                SET DOCPATH = C:\DOCS
  381.                SET FILTER = *.DOC *.TXT *.WPF
  382.                ADD
  383.                SET DOCPATH = C:\DOCS2
  384.                ADD
  385.                SET DOCPATH = C:\DOCS3
  386.                ADD
  387.  
  388.           This would add documents from C:\DOCS, C:\DOCS2, and C:\DOCS3 to
  389.           the index "MyIndex".
  390.  
  391.                The CREATE function needs to know both the name and the
  392.           directory for an index, and so both the SET INDEXNAME and the SET
  393.           INDEXPATH must be present to create an index.  The ADD function
  394.           just needs to know which index you want to add documents to, so
  395.           you can use either the name (SET INDEXNAME) or the path (SET
  396.           INDEXPATH) to specify the index.
  397.  
  398.           5.  Reindexing changed documents
  399.  
  400.                The REINDEX command in a script will cause dtSearch to
  401.           reindex any documents in an index that have been modified since
  402.           the index was last updated.  This is the batch mode equivalent to
  403.           the "Reindex changed documents" menu option.  Example:
  404.  
  405.                SET INDEXNAME = MyIndex
  406.                REINDEX
  407.  
  408.  
  409.  
  410.                                         - 9 -
  411.  
  412.           6.  Compressing an index
  413.  
  414.                To compress an index, use SET INDEXNAME or SET INDEXPATH to
  415.           specify the index to compress and then use the COMPRESS command. 
  416.           Example:
  417.  
  418.                SET INDEXNAME = MyIndex
  419.                COMPRESS
  420.  
  421.           7.  Complex scripts
  422.  
  423.                A script can do more than one indexing task.  For example,
  424.           this script would create the index MyIndex, add documents to it,
  425.           compress it, and then create a second index:
  426.  
  427.                SET INDEXNAME = MyIndex
  428.                SET INDEXPATH = c:\myindex
  429.                CREATE
  430.                SET DOCPATH = c:\docs
  431.                SET FILTER = *.doc *.wpf *.txt
  432.                ADD
  433.                COMPRESS
  434.                SET INDEXNAME = MyIndex II
  435.                SET INDEXPATH = c:\myindex2
  436.                CREATE
  437.  
  438.           Note that you do not need to specify the index name again after
  439.           the CREATE command.  dtSearch will remember the values given for
  440.           the previous command until you change them.